'\" te
.\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH UNCTRL 3XCURSES "Jun 5, 2002"
.SH NAME
unctrl \- generate printable representation of a character
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]

\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]

#include <unctrl.h>

\fBchar *\fR\fBunctrl\fR(\fBchtype\fR \fIc\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.na
\fB\fIc\fR\fR
.ad
.RS 5n
Is a character.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBunctrl()\fR function generates a character string that is a printable
representation of \fIc\fR. If \fIc\fR is a control character,it is converted to
the  \fB^\fR\fIX\fR notation. If \fIc\fR contains rendition information, the
effect is undefined.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, the \fBunctrl()\fR function returns the generated
string. Otherwise, it returns a null pointer.
.SH ERRORS
.sp
.LP
No errors are defined.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Standard
_
MT-Level	Unsafe
.TE

.SH SEE ALSO
.sp
.LP
.BR addch (3XCURSES),
.BR addstr (3XCURSES),
.BR libcurses (3XCURSES),
.BR wunctrl (3XCURSES),
.BR attributes (7),
.BR standards (7)
